# Q. What is this file?
# A. This file contains options which allow you to configure your multiworld experience while allowing
#    others to play how they want as well.
#
# Q. How do I use it?
# A. The options in this file are weighted. This means the higher number you assign to a value, the
#    more chances you have for that option to be chosen. For example, an option like this:
#
#    map_shuffle:
#      on: 5
#      off: 15
#
#    Means you have 5 chances for map shuffle to occur, and 15 chances for map shuffle to be turned
#    off.
#
# Q. I've never seen a file like this before. What characters am I allowed to use?
# A. This is a .yaml file. You are allowed to use most characters.
#    To test if your yaml is valid or not, you can use this website:
#        http://www.yamllint.com/
#    You can also verify that your Archipelago options are valid at this site:
#        https://archipelago.gg/check

# Your name in-game, limited to 16 characters.
#     {player} will be replaced with the player's slot number.
#     {PLAYER} will be replaced with the player's slot number, if that slot number is greater than 1.
#     {number} will be replaced with the counter value of the name.
#     {NUMBER} will be replaced with the counter value of the name, if the counter value is greater than 1.
name: Player{number}

# Used to describe your yaml. Useful if you have multiple files.
description: Default Ultimate Custom Night Template

game: Ultimate Custom Night
requires:
  version: 0.6.7 # Version of Archipelago required for this yaml to work as expected.
  game:
    Ultimate Custom Night: 0.1.1 # Version of the world required for this yaml to work as expected.

Ultimate Custom Night:
  ################
  # Game Options #
  ################
  progression_balancing:
    # A system that can move progression earlier, to try and prevent the player from getting stuck and bored early.
    # 
    # A lower setting means more getting stuck. A higher setting means less getting stuck.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 99
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-0-99: 0 # random value between 0 and 99
    disabled: 0 # equivalent to 0
    normal: 50 # equivalent to 50
    extreme: 0 # equivalent to 99

  accessibility:
    # Set rules for reachability of your items/locations.
    # 
    # **Full:** ensure everything can be reached and acquired.
    # 
    # **Minimal:** ensure what is needed to reach your goal can be acquired.
    full: 50
    minimal: 0

  target_points:
    # The high score required to win divided by 100.
    # Locations that require a higher score than the target are removed.
    # 
    # Note: When setting a score lower than 68, random animatronics will be excluded, including the ones you already excluded.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 50
    # Maximum value is 100
    68: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-50-100: 0 # random value between 50 and 100

  challenge_sanity:
    # Add challenges to the location and item pool.
    # 
    # When excluding animatronics, challenges those animatronics are part of also get excluded.
    'false': 50
    'true': 0

  scare_sanity:
    # Add jumpscares and animatronic debuffs as locations. NOT compatible with death link.
    # Animatronic debuffs mean any event that happens when you don't deal with the animatronic. (Example: BB taking your flashlight)
    'false': 50
    'true': 0

  hard_logic:
    # Require unintended techniques to ward off animatronics (e.g. camstalling, defeating animatronics with less than you're expected, etc.)
    # You may become softlocked - use with caution. Because of this, we recommend you type "Everything" into the YAML option called "non-local"
    'false': 50
    'true': 0

  trap_chance:
    # Chance of traps in the item pool.
    # Traps only replace filler Power-up items.
    # Current traps:
    #     DeeDee Trap
    #     Fake Audio Queue Trap
    #     Bankruptcy Trap
    #     Power Drain Trap
    #     XOR Trap (Extreme)
    #     Mute Audio Trap (Extreme)
    #     Monologue Trap (Extreme)
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 100
    35: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-0-100: 0 # random value between 0 and 100

  trap_chance_ex:
    # Chance of extreme traps in the item pool.
    # Extreme traps can only generate, if the filler item was always rolled to be a trap.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 0
    # Maximum value is 100
    10: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-0-100: 0 # random value between 0 and 100

  vanilla_dd:
    # Enable DeeDee to randomly spawn in the night like in vanilla UCN.
    # If enabled, DeeDee repels will also be added to the filler item pool.
    'false': 50
    'true': 0

  exclude_animatronics:
    # Exclude these animatronics from the item pool.
    # Incompatible with hard_logic
    # NOTE: When excluding animatronics, abilities that are only used by excluded animatronics also get removed.
    # 
    # (Example: When excluding Chica, it will also remove the Change Music item from the item pool, but won't remove the
    # Global Music Box, because Lefty and the Marionette also need it. If you remove them alongside Chica however,
    # the GMB will be excluded as well.)
    []

  death_link:
    # When you die, everyone who enabled death link dies. Of course, the reverse is true too.
    'false': 50
    'true': 0

  dl_amnesty:
    # The number of times you have to die to send a death link to everyone.
    #
    # You can define additional values between the minimum and maximum values.
    # Minimum value is 1
    # Maximum value is 10
    3: 50
    random: 0
    random-low: 0 # random value weighted towards lower values
    random-high: 0 # random value weighted towards higher values
    random-range-1-10: 0 # random value between 1 and 10

  ###########################
  # Item & Location Options #
  ###########################
  local_items:
    # Forces these items to be in their native world.
    []

  non_local_items:
    # Forces these items to be outside their native world.
    []

  start_inventory:
    # Start with the specified amount of these items. Example: "Bomb: 1"
    {}

  start_hints:
    # Start with these item's locations prefilled into the ``!hint`` command.
    []

  start_location_hints:
    # Start with these locations and their item prefilled into the ``!hint`` command.
    []

  exclude_locations:
    # Prevent these locations from having an important item.
    []

  priority_locations:
    # Prevent these locations from having an unimportant item.
    []

  item_links:
    # Share part of your item pool with other players.
    []

  plando_items:
    # Generic items plando.
    []
